<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>mipicsiss: function_prototype.c File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">mipicsiss
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="pages.html"><span>Examples</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('function__prototype_8c.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">function_prototype.c File Reference</div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Overview</h2>
<div class="textblock"><pre>
MODIFICATION HISTORY:</pre><pre>Ver   Who    Date     Changes
</p>
<hr/>
<p>
X.XX  XX     YY/MM/DD
1.00  RHe    19/09/20 Initial release.
</pre> </div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a0e803ea72f41466ba56bd78511996d8a"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="function__prototype_8c.html#a0e803ea72f41466ba56bd78511996d8a">SetupDSI</a> (void)</td></tr>
<tr class="memdesc:a0e803ea72f41466ba56bd78511996d8a"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function programs MIPI DSI SS with the required timing paramters.  <a href="#a0e803ea72f41466ba56bd78511996d8a">More...</a><br/></td></tr>
<tr class="separator:a0e803ea72f41466ba56bd78511996d8a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9af254929ec07e0b8e29ff28e18ec709"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="function__prototype_8c.html#a9af254929ec07e0b8e29ff28e18ec709">InitializeCsiRxSs</a> (void)</td></tr>
<tr class="memdesc:a9af254929ec07e0b8e29ff28e18ec709"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function programs MIPI CSI SS with the required timing paramters.  <a href="#a9af254929ec07e0b8e29ff28e18ec709">More...</a><br/></td></tr>
<tr class="separator:a9af254929ec07e0b8e29ff28e18ec709"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a34f1d639e40a40f098ceee99ce0857ac"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="function__prototype_8c.html#a34f1d639e40a40f098ceee99ce0857ac">EnableCSI</a> (void)</td></tr>
<tr class="separator:a34f1d639e40a40f098ceee99ce0857ac"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a571466dbec30928cd622090965a7ef0f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="function__prototype_8c.html#a571466dbec30928cd622090965a7ef0f">InitDSI</a> (void)</td></tr>
<tr class="memdesc:a571466dbec30928cd622090965a7ef0f"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function programs MIPI DSI SS with the required timing paramters.  <a href="#a571466dbec30928cd622090965a7ef0f">More...</a><br/></td></tr>
<tr class="separator:a571466dbec30928cd622090965a7ef0f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af9c3d5144d636d012b7ca70db1290ce2"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="function__prototype_8c.html#af9c3d5144d636d012b7ca70db1290ce2">DisableCSI</a> (void)</td></tr>
<tr class="separator:af9c3d5144d636d012b7ca70db1290ce2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae229cb3a71466b40c2ac44019d6a1795"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="function__prototype_8c.html#ae229cb3a71466b40c2ac44019d6a1795">DisableDSI</a> (void)</td></tr>
<tr class="separator:ae229cb3a71466b40c2ac44019d6a1795"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1404ec37649e5775142431036025c57a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="function__prototype_8c.html#a1404ec37649e5775142431036025c57a">resetIp</a> (void)</td></tr>
<tr class="memdesc:a1404ec37649e5775142431036025c57a"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function resets IPs.  <a href="#a1404ec37649e5775142431036025c57a">More...</a><br/></td></tr>
<tr class="separator:a1404ec37649e5775142431036025c57a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a666db801a5432f04f2f336d829c20294"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="function__prototype_8c.html#a666db801a5432f04f2f336d829c20294">demosaic</a> ()</td></tr>
<tr class="memdesc:a666db801a5432f04f2f336d829c20294"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function programs colour space converter with the given width and height.  <a href="#a666db801a5432f04f2f336d829c20294">More...</a><br/></td></tr>
<tr class="separator:a666db801a5432f04f2f336d829c20294"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aed289d1f35ee2c0136fa46e37ac775ff"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="function__prototype_8c.html#aed289d1f35ee2c0136fa46e37ac775ff">resetVIP</a> (void)</td></tr>
<tr class="separator:aed289d1f35ee2c0136fa46e37ac775ff"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8602d0639b2c2908365d62b96e5d1439"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="function__prototype_8c.html#a8602d0639b2c2908365d62b96e5d1439">InitIIC</a> ()</td></tr>
<tr class="memdesc:a8602d0639b2c2908365d62b96e5d1439"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function writes, reads, and verifies the data to the IIC EEPROM.  <a href="#a8602d0639b2c2908365d62b96e5d1439">More...</a><br/></td></tr>
<tr class="separator:a8602d0639b2c2908365d62b96e5d1439"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab74027af1cdd114fdeadd58f297e9533"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="function__prototype_8c.html#ab74027af1cdd114fdeadd58f297e9533">SendHandler</a> (XIic *InstancePtr)</td></tr>
<tr class="memdesc:ab74027af1cdd114fdeadd58f297e9533"><td class="mdescLeft">&#160;</td><td class="mdescRight">This Send handler is called asynchronously from an interrupt context and indicates that data in the specified buffer has been sent.  <a href="#ab74027af1cdd114fdeadd58f297e9533">More...</a><br/></td></tr>
<tr class="separator:ab74027af1cdd114fdeadd58f297e9533"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a87955d201525bc8c99bfb6a31494fca2"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="function__prototype_8c.html#a87955d201525bc8c99bfb6a31494fca2">ReceiveHandler</a> (XIic *InstancePtr)</td></tr>
<tr class="memdesc:a87955d201525bc8c99bfb6a31494fca2"><td class="mdescLeft">&#160;</td><td class="mdescRight">This Receive handler is called asynchronously from an interrupt context and indicates that data in the specified buffer has been Received.  <a href="#a87955d201525bc8c99bfb6a31494fca2">More...</a><br/></td></tr>
<tr class="separator:a87955d201525bc8c99bfb6a31494fca2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae2037c1d561c098886db8a61be2da667"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="function__prototype_8c.html#ae2037c1d561c098886db8a61be2da667">StatusHandler</a> (XIic *InstancePtr, int Event)</td></tr>
<tr class="memdesc:ae2037c1d561c098886db8a61be2da667"><td class="mdescLeft">&#160;</td><td class="mdescRight">This Status handler is called asynchronously from an interrupt context and indicates the events that have occurred.  <a href="#ae2037c1d561c098886db8a61be2da667">More...</a><br/></td></tr>
<tr class="separator:ae2037c1d561c098886db8a61be2da667"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a17a4a99f1e47e0b78cf69cb5d1d04c08"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="function__prototype_8c.html#a17a4a99f1e47e0b78cf69cb5d1d04c08">AdapterWriteData</a> (u16 ByteCount)</td></tr>
<tr class="memdesc:a17a4a99f1e47e0b78cf69cb5d1d04c08"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function writes a buffer of data to the Adapter IIC.  <a href="#a17a4a99f1e47e0b78cf69cb5d1d04c08">More...</a><br/></td></tr>
<tr class="separator:a17a4a99f1e47e0b78cf69cb5d1d04c08"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2d86e59a502d55d4193101c5f685cd8a"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="function__prototype_8c.html#a2d86e59a502d55d4193101c5f685cd8a">RunVDMA</a> (XAxiVdma *InstancePtr, int DeviceId, int hsize, int vsize, int buf_base_addr, int number_frame_count, int enable_frm_cnt_intr)</td></tr>
<tr class="memdesc:a2d86e59a502d55d4193101c5f685cd8a"><td class="mdescLeft">&#160;</td><td class="mdescRight">RunVDMA API.  <a href="#a2d86e59a502d55d4193101c5f685cd8a">More...</a><br/></td></tr>
<tr class="separator:a2d86e59a502d55d4193101c5f685cd8a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a329a2ed6a3ef5eae3c44593d358921b4"><td class="memItemLeft" align="right" valign="top">s32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="function__prototype_8c.html#a329a2ed6a3ef5eae3c44593d358921b4">WaitForCompletion</a> (s32 VdmaChannel, u32 *VdmaBaseAddr)</td></tr>
<tr class="memdesc:a329a2ed6a3ef5eae3c44593d358921b4"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function wait until the DMA channel halts.  <a href="#a329a2ed6a3ef5eae3c44593d358921b4">More...</a><br/></td></tr>
<tr class="separator:a329a2ed6a3ef5eae3c44593d358921b4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adb12280dc0e5dc20089aa30fee2b9ade"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="function__prototype_8c.html#adb12280dc0e5dc20089aa30fee2b9ade">ResetVDMA</a> ()</td></tr>
<tr class="memdesc:adb12280dc0e5dc20089aa30fee2b9ade"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function ResetVDMA.  <a href="#adb12280dc0e5dc20089aa30fee2b9ade">More...</a><br/></td></tr>
<tr class="separator:adb12280dc0e5dc20089aa30fee2b9ade"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="a17a4a99f1e47e0b78cf69cb5d1d04c08"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int AdapterWriteData </td>
          <td>(</td>
          <td class="paramtype">u16&#160;</td>
          <td class="paramname"><em>ByteCount</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function writes a buffer of data to the Adapter IIC. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">ByteCount</td><td>contains the number of bytes in the buffer to be written.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>XST_SUCCESS if successful else XST_FAILURE.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>The Byte count should not exceed the page size of the EEPROM as noted by the constant PAGE_SIZE. </dd></dl>

</div>
</div>
<a class="anchor" id="a666db801a5432f04f2f336d829c20294"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int demosaic </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function programs colour space converter with the given width and height. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">width</td><td>is Hsize of a packet in pixels. </td></tr>
    <tr><td class="paramname">height</td><td>is number of lines of a packet.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>Referenced by <a class="el" href="xmipi__sp701__example_8c.html#ae66f6b31b5ad750f1fe042a706a4e3d4">main()</a>.</p>

</div>
</div>
<a class="anchor" id="af9c3d5144d636d012b7ca70db1290ce2"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void DisableCSI </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<ul>
<li>This function disables MIPI CSI IP<ul>
<li><ul>
<li><dl class="section return"><dt>Returns</dt><dd>None.<ul>
<li><ul>
<li></li>
</ul>
</li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None.<ul>
<li></li>
</ul>
</dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>

<p>Referenced by <a class="el" href="function__prototype_8h.html#a56361447f4b2f2b7e4c28bd94e142116">resetIp()</a>.</p>

</div>
</div>
<a class="anchor" id="ae229cb3a71466b40c2ac44019d6a1795"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void DisableDSI </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<ul>
<li>This function disables MIPI DSI SS.<ul>
<li><ul>
<li><dl class="section return"><dt>Returns</dt><dd>None.<ul>
<li><ul>
<li></li>
</ul>
</li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None.<ul>
<li></li>
</ul>
</dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>

<p>Referenced by <a class="el" href="function__prototype_8h.html#a56361447f4b2f2b7e4c28bd94e142116">resetIp()</a>.</p>

</div>
</div>
<a class="anchor" id="a34f1d639e40a40f098ceee99ce0857ac"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void EnableCSI </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<ul>
<li>This function enables MIPI CSI IP<ul>
<li><ul>
<li><dl class="section return"><dt>Returns</dt><dd>None.<ul>
<li><ul>
<li></li>
</ul>
</li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None.<ul>
<li></li>
</ul>
</dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>

<p>Referenced by <a class="el" href="xmipi__sp701__example_8c.html#ae66f6b31b5ad750f1fe042a706a4e3d4">main()</a>.</p>

</div>
</div>
<a class="anchor" id="a571466dbec30928cd622090965a7ef0f"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void InitDSI </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function programs MIPI DSI SS with the required timing paramters. </p>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>Referenced by <a class="el" href="xmipi__example_8c.html#a840291bc02cba5474a4cb46a9b9566fe">main()</a>.</p>

</div>
</div>
<a class="anchor" id="a9af254929ec07e0b8e29ff28e18ec709"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 InitializeCsiRxSs </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function programs MIPI CSI SS with the required timing paramters. </p>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>Referenced by <a class="el" href="xmipi__example_8c.html#a840291bc02cba5474a4cb46a9b9566fe">main()</a>.</p>

</div>
</div>
<a class="anchor" id="a8602d0639b2c2908365d62b96e5d1439"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int InitIIC </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function writes, reads, and verifies the data to the IIC EEPROM. </p>
<p>It does the write as a single page write, performs a buffered read.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">None.</td><td></td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>XST_SUCCESS if successful else XST_FAILURE.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>Referenced by <a class="el" href="xmipi__example_8c.html#a840291bc02cba5474a4cb46a9b9566fe">main()</a>.</p>

</div>
</div>
<a class="anchor" id="a87955d201525bc8c99bfb6a31494fca2"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void ReceiveHandler </td>
          <td>(</td>
          <td class="paramtype">XIic *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This Receive handler is called asynchronously from an interrupt context and indicates that data in the specified buffer has been Received. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is not used, but contains a pointer to the IIC device driver instance which the handler is being called for.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>Referenced by <a class="el" href="pipeline__program_8h.html#af24a60bdd8657b70cd5138a7db89ef6c">SetupIICIntrHandlers()</a>.</p>

</div>
</div>
<a class="anchor" id="a1404ec37649e5775142431036025c57a"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void resetIp </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function resets IPs. </p>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="function__prototype_8c.html#af9c3d5144d636d012b7ca70db1290ce2">DisableCSI()</a>, <a class="el" href="function__prototype_8c.html#ae229cb3a71466b40c2ac44019d6a1795">DisableDSI()</a>, and <a class="el" href="function__prototype_8c.html#aed289d1f35ee2c0136fa46e37ac775ff">resetVIP()</a>.</p>

<p>Referenced by <a class="el" href="xmipi__sp701__example_8c.html#ae66f6b31b5ad750f1fe042a706a4e3d4">main()</a>.</p>

</div>
</div>
<a class="anchor" id="adb12280dc0e5dc20089aa30fee2b9ade"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void ResetVDMA </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function ResetVDMA. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">None</td><td></td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

</div>
</div>
<a class="anchor" id="aed289d1f35ee2c0136fa46e37ac775ff"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void resetVIP </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<ul>
<li>* This function resets and releases IPs<ul>
<li>*<ul>
<li>* <dl class="section return"><dt>Returns</dt><dd>None.<ul>
<li>*<ul>
<li>* </li>
</ul>
</li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None.<ul>
<li>* </li>
</ul>
</dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>

<p>Referenced by <a class="el" href="function__prototype_8h.html#a56361447f4b2f2b7e4c28bd94e142116">resetIp()</a>.</p>

</div>
</div>
<a class="anchor" id="a2d86e59a502d55d4193101c5f685cd8a"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int RunVDMA </td>
          <td>(</td>
          <td class="paramtype">XAxiVdma *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>DeviceId</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>hsize</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>vsize</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>buf_base_addr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>number_frame_count</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>enable_frm_cnt_intr</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>RunVDMA API. </p>
<p>This API is the interface between application and other API. When application will call this API with right argument, This API will call rest of the API to configure the read and write path of VDMA,based on ID. After that it will start both the read and write path of VDMA</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is the handle to XAxiVdma data structure. </td></tr>
    <tr><td class="paramname">DeviceId</td><td>is the device ID of current VDMA </td></tr>
    <tr><td class="paramname">hsize</td><td>is the horizontal size of the frame. It will be in Pixels. The actual size of frame will be calculated by multiplying this with tdata width. </td></tr>
    <tr><td class="paramname">vsize</td><td>is the Vertical size of the frame. </td></tr>
    <tr><td class="paramname">buf_base_addr</td><td>is the buffer address where frames will be written and read by VDMA. </td></tr>
    <tr><td class="paramname">number_frame_count</td><td>specifies after how many frames the interrupt should come. </td></tr>
    <tr><td class="paramname">enable_frm_cnt_intr</td><td>is for enabling frame count interrupt when set to 1. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS if example finishes successfully</li>
<li>XST_FAILURE if example fails. </li>
</ul>
</dd></dl>

</div>
</div>
<a class="anchor" id="ab74027af1cdd114fdeadd58f297e9533"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void SendHandler </td>
          <td>(</td>
          <td class="paramtype">XIic *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This Send handler is called asynchronously from an interrupt context and indicates that data in the specified buffer has been sent. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is not used, but contains a pointer to the IIC device driver instance which the handler is being called for.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>Referenced by <a class="el" href="pipeline__program_8h.html#af24a60bdd8657b70cd5138a7db89ef6c">SetupIICIntrHandlers()</a>.</p>

</div>
</div>
<a class="anchor" id="a0e803ea72f41466ba56bd78511996d8a"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 SetupDSI </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function programs MIPI DSI SS with the required timing paramters. </p>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>Referenced by <a class="el" href="xmipi__example_8c.html#a840291bc02cba5474a4cb46a9b9566fe">main()</a>.</p>

</div>
</div>
<a class="anchor" id="ae2037c1d561c098886db8a61be2da667"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void StatusHandler </td>
          <td>(</td>
          <td class="paramtype">XIic *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>Event</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This Status handler is called asynchronously from an interrupt context and indicates the events that have occurred. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the IIC driver instance for which the handler is being called for. </td></tr>
    <tr><td class="paramname">Event</td><td>indicates the condition that has occurred.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>Referenced by <a class="el" href="pipeline__program_8h.html#af24a60bdd8657b70cd5138a7db89ef6c">SetupIICIntrHandlers()</a>.</p>

</div>
</div>
<a class="anchor" id="a329a2ed6a3ef5eae3c44593d358921b4"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">s32 WaitForCompletion </td>
          <td>(</td>
          <td class="paramtype">s32&#160;</td>
          <td class="paramname"><em>VdmaChannel</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32 *&#160;</td>
          <td class="paramname"><em>VdmaBaseAddr</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function wait until the DMA channel halts. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">VdmaChannel</td><td>specifes VdmaChannel is MM2S or S2MM .</td></tr>
    <tr><td class="paramname">VdmaBaseAddr</td><td>VDMA base address</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>MM2S_HALT_SUCCESS, S2MM_HALT_SUCCESS in success MM2S_HALT_FAILURE, S2MM_HALT_FAILURE on failure</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
